

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Sub-Shapes [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Shape Scripts,Shape Scripts Subshape Layout,Subshape,Subshape In Shape Scripts,Subshape Example">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Sub-Shapes</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="displaying_element_properties.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="reserved_names.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText">Shapes can contain - and be composed of - other shapes.</span></p>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Subshape Layout</span></p>
<p class="p_BodyText"><span class="f_BodyText">To set the layout type, the </span><span class="f_BodyText" style="font-style: italic;">layoutType</span><span class="f_BodyText"> attribute must be set in the </span><span class="f_BodyText" style="font-weight: bold;">initialization attributes</span><span class="f_BodyText"> section of the script; in other words, before any of the methods are called. Valid values for this attribute are:</span></p>
<p class="p_SubHeadingL2"><span class="f_SubHeadingL2">LeftRight</span></p>
<p class="p_BodyText"><span class="f_BodyText">Shapes with</span><span class="f_BodyText" style="font-style: italic;"> leftright</span><span class="f_BodyText"> layout position subshapes side by side, with the first added on the left, and subsequent subshapes to the right.</span></p>
<p class="p_SubHeadingL2"><span class="f_SubHeadingL2">TopDown</span></p>
<p class="p_BodyText"><span class="f_BodyText" style="font-style: italic;">TopDown </span><span class="f_BodyText">places subshapes in a vertical arrangement, with the first shape added to the top and subsequent shape added below.</span></p>
<p class="p_SubHeadingL2"><span class="f_SubHeadingL2">Border</span></p>
<p class="p_BodyText"><span class="f_BodyText" style="font-style: italic;">Border</span><span class="f_BodyText"> layout requires an additional argument to the </span><span class="f_BodyText" style="font-style: italic;">addsubshape</span><span class="f_BodyText"> method to specify which region of the containing shape the subshape is to occupy: </span><span class="f_BodyText" style="font-style: italic;">N, E, S, W</span><span class="f_BodyText"> </span><span class="f_BodyText">or </span><span class="f_BodyText" style="font-style: italic;">CENTER</span><span class="f_BodyText">. Each region can only be occupied by one subshape.</span></p>
<p class="p_BodyText"><span class="f_BodyText">A subshape that is assigned to the </span><span class="f_BodyText" style="font-style: italic;">E</span><span class="f_BodyText"> or </span><span class="f_BodyText" style="font-style: italic;">W</span><span class="f_BodyText"> region must have its </span><span class="f_BodyText" style="font-style: italic;">preferredwidth</span><span class="f_BodyText"> attribute specified in its declaration. Similarly, subshapes added to </span><span class="f_BodyText" style="font-style: italic;">N</span><span class="f_BodyText"> or </span><span class="f_BodyText" style="font-style: italic;">S</span><span class="f_BodyText"> must have their </span><span class="f_BodyText" style="font-style: italic;">preferredheight</span><span class="f_BodyText"> attribute set. In this case, the values for these attributes are treated as static lengths and do not scale glyphs.</span></p>
<p class="p_BodyText"><span class="f_BodyText">&nbsp;</span></p>
<p class="p_BodyText"><span class="f_BodyText">For example:</span></p>
<p class="p_Code"><span class="f_Code">shape main</span></p>
<p class="p_Code"><span class="f_Code">{</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">layouttype=&quot;topdown&quot;;</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">setfillcolor{0,0,255};</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">rectangle{0,0,100,100};</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">addsubshape{&quot;sub&quot;,50,100,20,0};</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">addsubshape{&quot;sub&quot;,50,100,30,-100};</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">addsubshape{&quot;sub&quot;,50,100,40,-200};</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">addsubshape{&quot;sub&quot;,50,100,50,-300};</span></p>
<p class="p_Code"><span class="f_Code">&nbsp;</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">shape sub</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">{</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">setfillcolor{0,255,0};</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">ellipse{0,0,100,100};</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">}</span></p>
<p class="p_Code"><span class="f_Code">}</span></p>
<p class="p_BodyText"><span class="f_BodyText">&nbsp;</span></p>
<p class="p_BodyText"><span class="f_BodyText">The above script provides the following shape:</span></p>
<p class="p_TextIndentedL2"><img src="subshape%20example.png" width="231" height="149" border="0" alt="subshape example"></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
